/*
 * MIT License
 * Copyright (c) 2020 - 2024 _VIFEXTech
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef __FIFO_QUEUE_H
#define __FIFO_QUEUE_H

#include <cstddef>

template <class T, size_t SIZE>
class FifoQueue {
public:
    FifoQueue()
        : _head(0)
        , _tail(0) {};

    size_t available()
    {
        return (SIZE + _head - _tail) % SIZE;
    }

    size_t size()
    {
        return SIZE - 1;
    }

    bool full()
    {
        return (available() == size());
    }

    bool empty()
    {
        return (_head == _tail);
    }

    bool write(const T& data)
    {
        size_t i = (_head + 1) % SIZE;

        if (i == _tail) {
            return false;
        }

        _buffer[_head] = data;
        _head = i;
        return true;
    }

    bool read(T& data)
    {
        if (empty()) {
            return false;
        }

        data = _buffer[_tail];
        _tail = (_tail + 1) % SIZE;
        return true;
    }

    void flush()
    {
        _head = _tail;
    }

private:
    T _buffer[SIZE];
    size_t _head;
    size_t _tail;
};

#endif /* __FIFO_QUEUE_H */
